gtkscale: move documentation to inline comments
authorJavier Jardón <jjardon@gnome.org>
Wed, 1 Sep 2010 18:18:22 +0000 (20:18 +0200)
committerJavier Jardón <jjardon@gnome.org>
Wed, 1 Sep 2010 18:37:39 +0000 (20:37 +0200)
docs/reference/gtk/tmpl/.gitignore
docs/reference/gtk/tmpl/gtkscale.sgml [deleted file]
gtk/gtkscale.c

index ad67ef7d9a16f82ecde4863875027dd3b7a6b5d3..f0d29d1c36e26ce5b6b082fd54bbeafe9e430c47 100644 (file)
@@ -23,6 +23,7 @@ gtkrecentchooserdialog.sgml
 gtkrecentchoosermenu.sgml
 gtkrecentchooserwidget.sgml
 gtkrecentmanager.sgml
+gtkscale.sgml
 gtkscalebutton.sgml
 gtkseparator.sgml
 gtkseparatormenuitem.sgml
diff --git a/docs/reference/gtk/tmpl/gtkscale.sgml b/docs/reference/gtk/tmpl/gtkscale.sgml
deleted file mode 100644 (file)
index e4e6d51..0000000
+++ /dev/null
@@ -1,193 +0,0 @@
-<!-- ##### SECTION Title ##### -->
-GtkScale
-
-<!-- ##### SECTION Short_Description ##### -->
-Base class for GtkHScale and GtkVScale
-
-<!-- ##### SECTION Long_Description ##### -->
-<para>
-A #GtkScale is a slider control used to select a numeric value.
-To use it, you'll probably want to investigate the methods on
-its base class, #GtkRange, in addition to the methods for #GtkScale itself.
-To set the value of a scale, you would normally use gtk_range_set_value().
-To detect changes to the value, you would normally use the "value_changed"
-signal.
-</para>
-
-<refsect2 id="GtkScale-BUILDER-UI"><title>GtkScale as GtkBuildable</title>
-<para>
-GtkScale supports a custom &lt;marks&gt; element, which
-can contain multiple &lt;mark&gt; elements. The "value" and "position"
-attributes have the same meaning as gtk_scale_add_mark() parameters of the
-same name. If the element is not empty, its content is taken as the markup
-to show at the mark. It can be translated with the usual "translatable and
-"context" attributes.
-</para>
-</refsect2>
-
-<!-- ##### SECTION See_Also ##### -->
-<para>
-
-</para>
-
-<!-- ##### SECTION Stability_Level ##### -->
-
-
-<!-- ##### SECTION Image ##### -->
-
-
-<!-- ##### STRUCT GtkScale ##### -->
-<para>
-The fields of the #GtkScale-struct struct should only be accessed via
-the accessor functions.
-</para>
-
-
-<!-- ##### SIGNAL GtkScale::format-value ##### -->
-<para>
-
-</para>
-
-@scale: 
-@value: 
-@Returns: 
-
-<!-- ##### ARG GtkScale:digits ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkScale:draw-value ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkScale:value-pos ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkScale:slider-length ##### -->
-<para>
-
-</para>
-
-<!-- ##### ARG GtkScale:value-spacing ##### -->
-<para>
-
-</para>
-
-<!-- ##### FUNCTION gtk_scale_new ##### -->
-<para>
-
-</para>
-
-@orientation: 
-@adjustment: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_scale_new_with_range ##### -->
-<para>
-
-</para>
-
-@orientation: 
-@min: 
-@max: 
-@step: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_scale_set_digits ##### -->
-<para>
-
-</para>
-
-@scale: 
-@digits: 
-
-
-<!-- ##### FUNCTION gtk_scale_set_draw_value ##### -->
-<para>
-
-</para>
-
-@scale: 
-@draw_value: 
-
-
-<!-- ##### FUNCTION gtk_scale_set_value_pos ##### -->
-<para>
-
-</para>
-
-@scale: 
-@pos: 
-
-
-<!-- ##### FUNCTION gtk_scale_get_digits ##### -->
-<para>
-
-</para>
-
-@scale: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_scale_get_draw_value ##### -->
-<para>
-
-</para>
-
-@scale: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_scale_get_value_pos ##### -->
-<para>
-
-</para>
-
-@scale: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_scale_get_layout ##### -->
-<para>
-
-</para>
-
-@scale: 
-@Returns: 
-
-
-<!-- ##### FUNCTION gtk_scale_get_layout_offsets ##### -->
-<para>
-
-</para>
-
-@scale: 
-@x: 
-@y: 
-
-
-<!-- ##### FUNCTION gtk_scale_add_mark ##### -->
-<para>
-
-</para>
-
-@scale: 
-@value: 
-@position: 
-@markup: 
-
-
-<!-- ##### FUNCTION gtk_scale_clear_marks ##### -->
-<para>
-
-</para>
-
-@scale: 
-
-
index e03013dc2309eb9be51301b07bfdc084d0823d2c..853b1cf769abf7be26e95a8de80ee2059912fc4b 100644 (file)
 #include "gtkbuildable.h"
 #include "gtkbuilderprivate.h"
 
+
+/**
+ * SECTION:gtkscale
+ * @Short_description: Base class for #GtkHScale and #GtkVScale
+ * @Title: GtkScale
+ *
+ * A #GtkScale is a slider control used to select a numeric value.
+ * To use it, you'll probably want to investigate the methods on
+ * its base class, #GtkRange, in addition to the methods for #GtkScale itself.
+ * To set the value of a scale, you would normally use gtk_range_set_value().
+ * To detect changes to the value, you would normally use the
+ * #GtkRange::value_changed signal.
+ *
+ * <refsect2 id="GtkScale-BUILDER-UI"><title>GtkScale as GtkBuildable</title>
+ * GtkScale supports a custom &lt;marks&gt; element, which
+ * can contain multiple &lt;mark&gt; elements. The "value" and "position"
+ * attributes have the same meaning as gtk_scale_add_mark() parameters of the
+ * same name. If the element is not empty, its content is taken as the markup
+ * to show at the mark. It can be translated with the usual "translatable and
+ * "context" attributes.
+ * </refsect2>
+ */
+
+
 #define        MAX_DIGITS      (64)    /* don't change this,
                                 * a) you don't need to and
                                 * b) you might cause buffer owerflows in